doxygen: fixed build warning for RT_CAN_FILTER_ITEM_INIT#10758
doxygen: fixed build warning for RT_CAN_FILTER_ITEM_INIT#10758supperthomas merged 1 commit intoRT-Thread:masterfrom
Conversation
The names and number of macro parameters in doxygen comments must match the actual macro definition; otherwise, a warning will be generated. Our goal is to eliminate all warnings. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
|
👋 感谢您对 RT-Thread 的贡献！Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范，请在你的仓库中执行以下步骤运行代码格式化工作流（如果格式化CI运行失败）。 🛠 操作步骤 | Steps
完成后，提交将自动更新至 如有问题欢迎联系我们，再次感谢您的贡献！💐 |
📌 Code Review Assignment🏷️ Tag: componentsReviewers: @Maihuanyi Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-09-28 17:00 CST)
📝 Review Instructions
|
|
@wdfk-prog 请一起看一下，因为我发现这个问题是 11156de “feat[can]: Implement non-blocking send mechanism and enhance CAN driver functionality” 所引入的。你是这个补丁的作者。谢谢。 另外请注意：我发现 doxygen 不支持在注释中对参数标记为可选（optional), 所以对于这种不同宏下的同名不同参数的方式，只能分别写注释。而且因为默认 RT_CAN_USING_HDR 没有加入 
或许可以采用变参的方式定义宏？目前这种同名不同参数的方式也是很容易引起疑惑的，相当于两个API 了。 |
|
@Rbb666 有个建议，是否可以把 doxygen doc build 的 action 加入 ci，这样在 pr 提交阶段就可以发现这些告警了。 |
|
有这个ci，后面合并的时候要关注下了😅： 
|
3 participants
该问题是 11156de “feat[can]: Implement non-blocking send mechanism and enhance CAN driver functionality” 所引入的。
doxygen 注释中宏参数的名字和个数必须和宏的实际定义一致，否则会告警。
我们的目标是消除所有的告警。